<!DOCTYPE html>
<html lang="en-US">
    <head>
        <title>IO::Interactive - Utilities for interactive I/O - metacpan.org</title>
        <link rel="preload" as="fetch" href="https://metacpan.org/account/login_status" crossorigin="anonymous" />
        <link href="https://metacpan.org/_assets/b8ccceeed47a0652049703d99326a9cea4933443.css" rel="stylesheet" type="text/css">
        <script src="https://metacpan.org/_assets/6bfedafe2d7caa915b7d84f61b45936818e3242e.js" type="text/javascript" defer></script>
        <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of IO-Interactive - MetaCPAN" href="https://metacpan.org/dist/IO-Interactive/releases.rss" />
        <link rel="canonical" href="./IO::Interactive.html" />
        <meta name="description" content="Utilities for interactive I/O" />
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5">
        <link rel="shortcut icon" href="https://metacpan.org/static/icons/favicon.ico">
        <link rel="apple-touch-icon" sizes="152x152" href="https://metacpan.org/static/icons/apple-touch-icon.png">
        <link rel="search" href="https://metacpan.org/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN">
        <script>
          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

          (function(skey, ga_id){
            ga('create', ga_id, {
              siteSpeedSampleRate : 100,
              storage             : 'none',
              clientId            : localStorage.getItem(skey)
            });
            ga(function(tracker) {
              localStorage.setItem(skey, tracker.get('clientId'));
            });
            ga('send', 'pageview');
          })('ga:clientId', 'UA-27829474-1');
        </script>
<meta name="twitter:card"        content="summary" />
<meta name="twitter:url"         content="https://metacpan.org/pod/IO::Interactive" />
<meta name="twitter:title"       content="IO::Interactive" />
<meta name="twitter:description" content="Utilities for interactive I/O" />
<meta name="twitter:site"        content="metacpan" />
    </head>
    <body>
        <nav class="navbar navbar-default" role="navigation">
            <div class="header-logo-large hidden-xs">
              <a href="https://metacpan.org/" tabindex="0">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#logo" />
                </svg>
              </a>
            </div>
            <div class="header-logo-icon visible-xs">
              <a href="https://metacpan.org/">
                <svg class="logo" aria-label="MetaCPAN">
                  <use class="logo" href="/static/images/metacpan-logo.svg#dots" />
                </svg>
              </a>
            </div>
            <ul class="nav navbar-nav menu-items hidden-xs hidden-sm">
              <li><a href="https://metacpan.org/about">About</a></li>
              <li><a href="https://metacpan.org/about/sponsors">Sponsor</a></li>
              <li><a href="https://grep.metacpan.org/">grep::cpan</a></li>
              <li><a href="https://metacpan.org/recent">Recent</a></li>
              <li><a href="https://metacpan.org/about/faq">FAQ</a></li>
              <li><a href="https://metacpan.org/tools">Tools</a></li>
              <li><a href="https://fastapi.metacpan.org/">API</a></li>
            </ul>
            <ul class="nav navbar-nav navbar-right">
                <button type="button" class="searchbar-btn visible-xs visible-sm">
                    <i class="fa fa-search button-fa-icon"></i>
                </button>
                <form action="https://metacpan.org/search" class="searchbar-form visible-md visible-lg search-form form-horizontal">
                   <input type="hidden" name="size" id="metacpan_search-size" value="20">
                  <div class="form-group">
                      <div class="search-group">
                        <i class="fa fa-search"></i>
                        <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value="">
                      </div>
                  </div>
                </form>
                    <li class="icon-slidepanel visible-xs visible-sm">
                      <button data-toggle="slidepanel" data-target=".slidepanel">
                        <span class="button-fa-icon">
                          <i class="fa fa-bars slidepanel-open"></i>
                          <i class="fa fa-times slidepanel-close"></i>
                        </span>
                      </button>
                    </li>
                <form action="https://metacpan.org/account/logout" method="POST" id="metacpan-logout"></form>
                <li class="dropdown logged_in" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li><a href="https://metacpan.org/account/identities">Identities</a></li>
                        <li><a href="https://metacpan.org/account/profile">Profile</a></li>
                        <li><a href="https://metacpan.org/account/favorite/list">Favorites</a></li>
                        <li>
                            <a href="./IO::Interactive.html#" type="button" onclick="$('#metacpan-logout').submit(); return false">
                              Logout
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_out" style="display: none;">
                    <button type="button" class="dropdown-toggle" data-toggle="dropdown">
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                      <i class="fas fa-chevron-down"></i>
                    </button>
                    <ul class="dropdown-menu">
                        <li>
                            <a href="https://metacpan.org/login/github">
                                <i class="fab fa-github fa-fw"></i>
                                GitHub
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/twitter">
                                <i class="fab fa-twitter fa-fw"></i>
                                Twitter
                            </a>
                        </li>
                        <li>
                            <a href="https://metacpan.org/login/google">
                                <i class="fab fa-google fa-fw"></i>
                                Google
                            </a>
                        </li>
                    </ul>
                </li>
                <li class="dropdown logged_placeholder">
                    <button>
                      <i class="fa fa-user button-fa-icon" aria-hidden="true"></i>
                    </button>
                </li>
            </ul>
        </nav>
        <div class="page-content ">
          <!--
          <div class="top-notify-banner">
            <i class="fas fa-info-circle"></i>
          </div>
          -->
          <nav class="sidebar">
            <div class="slidepanel">
              <ul class="nav-list ">
    <li class="nav-header no-margin-top">
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of IO-Interactive was released.">
      <span class="relatize">05 Jul 2023 15:03:42 UTC</span>
    </li>
  <li>
    Distribution: <a href="https://metacpan.org/dist/IO-Interactive">IO-Interactive</a>
  </li>
  <li>
    Module version: 1.025
  </li>
  <li>
    <a data-keyboard-shortcut="g s" href="https://metacpan.org/dist/IO-Interactive/source/lib/IO/Interactive.pm">Source</a>
    (<a href="https://metacpan.org/dist/IO-Interactive/source/lib/IO/Interactive.pm?raw=1">raw</a>)
  </li>
  <li>
    <a data-keyboard-shortcut="g b" href="https://metacpan.org/dist/IO-Interactive/source/lib/IO">Browse</a>
    (<a href="https://metacpan.org/dist/IO-Interactive/source/lib/IO?raw=1">raw</a>)
  </li>
    <li>
      <a data-keyboard-shortcut="g c" href="https://metacpan.org/dist/IO-Interactive/changes">Changes</a>
    </li>
    <li>
      <a rel="noopener nofollow" class="nopopup" href="https://github.com/briandfoy/io-interactive">Homepage</a>
    </li>
    <li>
      <a class="nopopup" href="https://metacpan.org/dist/IO-Interactive/contribute">How to Contribute</a>
    </li>
    <li>
        <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/briandfoy/io-interactive">Repository</a>
    </li>
    <li>
      <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/briandfoy/io-interactive/issues">Issues</a>
      (1)
    </li>
    <li>
      <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=IO-Interactive+1.025" title="Matrix">Testers</a>
        <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Interactive.html?oncpan=1&amp;distmat=1&amp;version=1.025&amp;grade=2" style="color: #090">2235</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Interactive.html?oncpan=1&amp;distmat=1&amp;version=1.025&amp;grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/I/IO-Interactive.html?oncpan=1&amp;distmat=1&amp;version=1.025&amp;grade=4">0</a>)</span>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/BDFOY/IO-Interactive-1.025">Kwalitee</a>
    </li>
    <li>
      <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on IO-Interactive who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)">
      Bus factor: 2
      </div>
    </li>
    <li>
      <a rel="noopener nofollow" href="http://cpancover.com/latest/IO-Interactive-1.025/index.html">46.67% Coverage </a>
    </li>
    <li>
      License: artistic_2
    </li>
    <li>
      Perl: v5.8.0
    </li>
    <li class="nav-header">Activity</li>
    <li>
<div class="activity-graph">
    <img src="https://metacpan.org/dist/IO-Interactive/activity.svg?res=month" />
    <div class="comment">24 month</div>
</div>
    </li>
    <li class="nav-header">Tools</li>
    <li>
      <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/B/BD/BDFOY/IO-Interactive-1.025.tar.gz">
      Download (<span itemprop="fileSize">12.79KB</span>)</a>
    </li>
    <li>
      <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FBDFOY%2FIO-Interactive-1.025%2Flib%2FIO%2FInteractive.pm">
        MetaCPAN Explorer
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/IO-Interactive/permissions">
        Permissions
      </a>
    </li>
    <li>
      <a href="https://metacpan.org/dist/IO-Interactive/releases.rss">
        Subscribe to distribution
      </a>
    </li>
    <li>
      <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog">
        Install Instructions
      </button>
    </li>
    <li>
      <form action="https://metacpan.org/search">
        <input type="hidden" name="q" value="dist:IO-Interactive">
        <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
      </form>
    </li>
    <li>
      <form action="https://grep.metacpan.org/search">
        <input type="hidden" name="qd" value="IO-Interactive">
        <input type="hidden" name="source" value="metacpan">
        <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form">
        <input type="submit" style="display: none">
     </form>
    </li>
    <li class="version-jump">
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/IO/Interactive.pm&#39;" class="form-control tool-bar-form">
  <option disabled selected>Jump to version</option>
<option
  disabled
  value="BDFOY/IO-Interactive-1.025"
>1.025
  (BDFOY on 2023-07-05)</option>
<option
  
  value="BDFOY/IO-Interactive-1.023"
>1.023
  (BDFOY on 2021-02-03)</option>
<option
  
  value="BDFOY/IO-Interactive-1.022"
>1.022
  (BDFOY on 2016-09-04)</option>
<option
  
  value="DCONWAY/IO-Interactive-v0.0.3"
>v0.0.3
  (DCONWAY on 2006-02-17)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.0.2"
>0.0.2
  (DCONWAY on 2005-05-22)</option>
<optgroup label="BackPAN">'
<option
  
  value="BDFOY/IO-Interactive-1.021_02"
>1.021_02 DEV
  (BDFOY on 2016-08-30)</option>
<option
  
  value="BDFOY/IO-Interactive-1.021"
>1.021
  (BDFOY on 2016-01-27)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.6"
>0.0.6
  (BDFOY on 2009-11-13)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.5"
>0.0.5
  (BDFOY on 2009-01-15)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.4"
>0.0.4
  (BDFOY on 2008-08-31)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.3_01"
>0.0.3_01 DEV
  (BDFOY on 2008-08-24)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.01"
>0.01
  (DCONWAY on 2005-05-14)</option>
</optgroup>
</select>
    </li>
    <li class="version-diff">
<select onchange="document.location.href='/release/BDFOY/IO-Interactive-1.025/diff/' + encodeURIComponent(this.value) + '/lib/IO/Interactive.pm'
" class="form-control tool-bar-form">
  <option disabled selected>Diff with version</option>
<option
  disabled
  value="BDFOY/IO-Interactive-1.025"
>1.025
  (BDFOY on 2023-07-05)</option>
<option
  
  value="BDFOY/IO-Interactive-1.023"
>1.023
  (BDFOY on 2021-02-03)</option>
<option
  
  value="BDFOY/IO-Interactive-1.022"
>1.022
  (BDFOY on 2016-09-04)</option>
<option
  
  value="DCONWAY/IO-Interactive-v0.0.3"
>v0.0.3
  (DCONWAY on 2006-02-17)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.0.2"
>0.0.2
  (DCONWAY on 2005-05-22)</option>
<optgroup label="BackPAN">'
<option
  
  value="BDFOY/IO-Interactive-1.021_02"
>1.021_02 DEV
  (BDFOY on 2016-08-30)</option>
<option
  
  value="BDFOY/IO-Interactive-1.021"
>1.021
  (BDFOY on 2016-01-27)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.6"
>0.0.6
  (BDFOY on 2009-11-13)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.5"
>0.0.5
  (BDFOY on 2009-01-15)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.4"
>0.0.4
  (BDFOY on 2008-08-31)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.3_01"
>0.0.3_01 DEV
  (BDFOY on 2008-08-24)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.01"
>0.01
  (DCONWAY on 2005-05-14)</option>
</optgroup>
</select>
    </li>

    <li>
<ul class="dependencies">
  <li class="nav-header">Dependencies</li>
  <li><i class="ttip" title="dynamic_config enabled">unknown</i></li>
  <li>
    <hr>
  </li>
  <li>
    <a href="https://metacpan.org/module/IO::Interactive/requires">Reverse dependencies</a>
  </li>
  <li>
    <a href="http://deps.cpantesters.org/?module=IO%3A%3AInteractive">CPAN Testers List</a>
  </li>
  <li>
    <a href="https://cpandeps.grinnz.com/?dist=IO-Interactive">Dependency graph</a>
  </li>
</ul>
    </li>
    <li class="nav-header">Permalinks</li>
    <li>
      <a href="https://metacpan.org/release/BDFOY/IO-Interactive-1.025/view/lib/IO/Interactive.pm">This version</a>
    </li>
    <li>
      <a href="./IO::Interactive.html">Latest version</a>
    </li>
    <li>
<div class="plussers">
<div class="nav-header">++ed by:</div>
<div>
<a class="display-all" href="https://metacpan.org/author/MISHIN"><img src="https://www.gravatar.com/avatar/7aefe037fc617ef89780ad89de3deb87?d=identicon&amp;s=20" title="MISHIN" alt="MISHIN"></a>
<a class="display-all" href="https://metacpan.org/author/SSCAFFIDI"><img src="https://www.gravatar.com/avatar/2b2258ad3913c3d9a32123b905101a8b?d=identicon&amp;s=20" title="SSCAFFIDI" alt="SSCAFFIDI"></a>
<a class="display-all" href="https://metacpan.org/author/DAGOLDEN"><img src="https://www.gravatar.com/avatar/bb755c989fcb9897f28a2c6e00df61e2?d=identicon&amp;s=20" title="DAGOLDEN" alt="DAGOLDEN"></a>
<a class="display-all" href="https://metacpan.org/author/KEEDI"><img src="https://www.gravatar.com/avatar/95f905a7a4ccc573c711e9d264c0fde8?d=identicon&amp;s=20" title="KEEDI" alt="KEEDI"></a>
<a class="display-all" href="https://metacpan.org/author/PINGAN"><img src="https://www.gravatar.com/avatar/a02222e5e0e4fd24d52fc29a08ac6bcb?d=identicon&amp;s=20" title="PINGAN" alt="PINGAN"></a>
</div>
<!-- Display counts of plussers-->
<div>
    <a href="https://metacpan.org/dist/IO-Interactive/plussers">8 PAUSE users</a>
</div>
<div>
    7 non-PAUSE users
</div>
</div>
    </li>
    <li>
<div id="metacpan_contributors">
  <div>
    <button class="btn-link"
      onclick="$(this).hide(); $('#metacpan_contributors ul').slideDown(); return false;"
    >and 1 contributors</button>
  </div>
  <ul style="display: none">
    <li class="contributor"
      data-cpan-author="DCONWAY"
      data-contrib-email="DCONWAY@cpan.org"
    >
      <a href="https://metacpan.org/author/DCONWAY" class="cpan-author">
      <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/3d4a6a089964a744d7b3cf2415f81951?d=identicon&amp;s=20" />
      Damian Conway
      </a>
    </li>
  </ul>
</div>
    </li>
              </ul>
            </div>
          </nav>
          <div class="content-navigation">
<div class="breadcrumbs">
  <span>
    <a data-keyboard-shortcut="g a" rel="author" href="https://metacpan.org/author/BDFOY" class="author-name">brian d foy</a>
  </span>
  <span>&nbsp;/&nbsp;</span>
  <div class="release dist-release status-latest maturity-released">
    <span class="dropdown"><b class="caret"></b></span>
<select onchange="document.location.href=&#39;/release/&#39;+this.value+&#39;/view/lib/IO/Interactive.pm&#39;" class="">
<option
  selected
  value="BDFOY/IO-Interactive-1.025"
>1.025
  (BDFOY on 2023-07-05)</option>
<option
  
  value="BDFOY/IO-Interactive-1.023"
>1.023
  (BDFOY on 2021-02-03)</option>
<option
  
  value="BDFOY/IO-Interactive-1.022"
>1.022
  (BDFOY on 2016-09-04)</option>
<option
  
  value="DCONWAY/IO-Interactive-v0.0.3"
>v0.0.3
  (DCONWAY on 2006-02-17)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.0.2"
>0.0.2
  (DCONWAY on 2005-05-22)</option>
<optgroup label="BackPAN">'
<option
  
  value="BDFOY/IO-Interactive-1.021_02"
>1.021_02 DEV
  (BDFOY on 2016-08-30)</option>
<option
  
  value="BDFOY/IO-Interactive-1.021"
>1.021
  (BDFOY on 2016-01-27)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.6"
>0.0.6
  (BDFOY on 2009-11-13)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.5"
>0.0.5
  (BDFOY on 2009-01-15)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.4"
>0.0.4
  (BDFOY on 2008-08-31)</option>
<option
  
  value="BDFOY/IO-Interactive-0.0.3_01"
>0.0.3_01 DEV
  (BDFOY on 2008-08-24)</option>
<option
  
  value="DCONWAY/IO-Interactive-0.01"
>0.01
  (DCONWAY on 2005-05-14)</option>
</optgroup>
</select>
    <a data-keyboard-shortcut="g d" class="release-name" href="https://metacpan.org/dist/IO-Interactive">IO-Interactive-1.025</a>
  </div>
<span class="river-gauge-gauge">
  <svg width="24px"
       height="15px"
       version="1.1"
       xmlns="http://www.w3.org/2000/svg"
       xmlns:xlink="http://www.w3.org/1999/xlink">

    <g>
      <title>        River stage three &#10;
          • 45 direct dependents &#10;          • 574 total dependents
      </title>

      <rect x="0"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="5"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="10"  y="0" width="4" height="15" fill="#7ea3f2" />
      <rect x="15"  y="0" width="4" height="15" fill="#e4e2e2" />
      <rect x="20"  y="0" width="4" height="15" fill="#e4e2e2" />
    </g>
  </svg>

</span>
<div id="IO-Interactive-fav" class="logged_in">
<form action="https://metacpan.org/account/favorite/add" style="display: inline" onsubmit="return favDistribution(this)">
    <input type="hidden" name="remove" value="0">
    <input type="hidden" name="release" value="IO-Interactive-1.025">
    <input type="hidden" name="author" value="BDFOY">
    <input type="hidden" name="distribution" value="IO-Interactive">
    <button type="submit" class="favorite highlight"><span>15</span> ++</button>
</form>
</div>
<div class="logged_out">
<a href="./IO::Interactive.html" onclick="alert('Please sign in to add favorites'); return false" class="favorite highlight">
<span>15</span> ++</a>
</div>
   / <span>IO::Interactive</span>
</div>
          </div>
          <main class="content">


<nav class="toc">
  <div class="toc-header"><strong>Contents</strong></div>
<ul>
  <li><a href="./IO::Interactive.html#NAME">NAME</a></li>
  <li><a href="./IO::Interactive.html#VERSION">VERSION</a></li>
  <li><a href="./IO::Interactive.html#SYNOPSIS">SYNOPSIS</a></li>
  <li><a href="./IO::Interactive.html#DESCRIPTION">DESCRIPTION</a></li>
  <li><a href="./IO::Interactive.html#DIAGNOSTICS">DIAGNOSTICS</a></li>
  <li><a href="./IO::Interactive.html#CONFIGURATION-AND-ENVIRONMENT">CONFIGURATION AND ENVIRONMENT</a></li>
  <li><a href="./IO::Interactive.html#DEPENDENCIES">DEPENDENCIES</a></li>
  <li><a href="./IO::Interactive.html#INCOMPATIBILITIES">INCOMPATIBILITIES</a></li>
  <li><a href="./IO::Interactive.html#BUGS-AND-LIMITATIONS">BUGS AND LIMITATIONS</a></li>
  <li><a href="./IO::Interactive.html#SOURCE-AVAILABILITY">SOURCE AVAILABILITY</a></li>
  <li><a href="./IO::Interactive.html#AUTHOR">AUTHOR</a></li>
  <li><a href="./IO::Interactive.html#LICENCE-AND-COPYRIGHT">LICENCE AND COPYRIGHT</a></li>
  <li><a href="./IO::Interactive.html#DISCLAIMER-OF-WARRANTY">DISCLAIMER OF WARRANTY</a></li>
</ul></nav>
<div class="pod anchors">
<h1 id="NAME">NAME</h1>

<p>IO::Interactive - Utilities for interactive I/O</p>

<h1 id="VERSION">VERSION</h1>

<p>This document describes IO::Interactive version 1.02</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use IO::Interactive qw(is_interactive interactive busy);

    if ( is_interactive() ) {
        print &quot;Running interactively\n&quot;;
    }

    # or...

    print {interactive} &quot;Running interactively\n&quot;;


    $fh = busy {
        do_noninteractive_stuff();
    }</code></pre>

<h1 id="DESCRIPTION">DESCRIPTION</h1>

<p>This module provides three utility subroutines that make it easier to develop interactive applications.</p>

<p>The <code>ARGV</code> filehandle, the one that <code>&lt;&gt;</code> or an empty <code>readline()</code> uses, has various magic associated with it. It&#39;s not actually opened until you try to read from it. Checking <code>-t ARGV</code> before you&#39;ve tried to read from it might give you the wrong answer. Not only that, you might not read from <code>ARGV</code>. If the value in <code>@ARGV</code> is the magic filename <code>-</code> (a convention to mean the standard filehandle for input or output), <code>ARGV</code> might actually be <code>STDIN</code>. You don&#39;t want to think about all of this. This module is discussed in <i>Perl Best Practices</i> on page 218. Also see the <code>ARGV</code> entry in <a href="variables/$&lt;digits&gt;-($1,-$2,-...).html">perlvar</a> and the <code>readline</code> entry in <a href="functions/CORE.html">perlfunc</a>.</p>

<dl>

<dt id="is_interactive()"><a id="is_interactive"></a><code>is_interactive()</code></dt>
<dd>

<p>This subroutine returns true if <code>*ARGV</code> and the currently selected filehandle (usually <code>*STDOUT</code>) are connected to the terminal. The test is considerably more sophisticated than:</p>

<pre><code>    -t *ARGV &amp;&amp; -t *STDOUT</code></pre>

<p>as it takes into account the magic behaviour of <code>*ARGV</code>.</p>

<p>You can also pass <code>is_interactive</code> a writable filehandle, in which case it requires that filehandle be connected to a terminal (instead of the currently selected). The usual suspect here is <code>*STDERR</code>:</p>

<pre><code>    if ( is_interactive(*STDERR) ) {
        carp $warning;
    }</code></pre>

<p>Note that <code>is_interactive</code> may return true in a Windows Scheduled Task. See Github #6 (https://github.com/briandfoy/io-interactive/issues/6).</p>

</dd>
<dt id="interactive()"><a id="interactive"></a><code>interactive()</code></dt>
<dd>

<p>This subroutine returns <code>*STDOUT</code> if <code>is_interactive</code> is true. If <code>is_interactive()</code> is false, <code>interactive</code> returns a filehandle that does not print.</p>

<p>This makes it easy to create applications that print out only when the application is interactive:</p>

<pre><code>    print {interactive} &quot;Please enter a value: &quot;;
    my $value = &lt;&gt;;</code></pre>

<p>You can also pass <code>interactive</code> a writable filehandle, in which case it writes to that filehandle if it is connected to a terminal (instead of writing to <code>*STDOUT</code>). Once again, the usual suspect is <code>*STDERR</code>:</p>

<pre><code>    print {interactive(*STDERR)} $warning;</code></pre>

</dd>
<dt id="busy-{...}"><a id="busy"></a><code>busy {...}</code></dt>
<dd>

<p>This subroutine takes a block as its single argument and executes that block. Whilst the block is executed, <code>*ARGV</code> is temporarily replaced by a closed filehandle. That is, no input from <code>*ARGV</code> is possible in a <code>busy</code> block. Furthermore, any attempts to send input into the <code>busy</code> block through <code>*ARGV</code> is intercepted and a warning message is printed to <code>*STDERR</code>. The <code>busy</code> call returns a filehandle that contains the intercepted input.</p>

<p>A <code>busy</code> block is therefore useful to prevent attempts at input when the program is busy at some non-interactive task.</p>

</dd>
</dl>

<h1 id="DIAGNOSTICS">DIAGNOSTICS</h1>

<dl>

<dt id="Unknown-subroutine-(%s)-requested"><a id="Unknown"></a><a id="Unknown-subroutine--s--requested"></a>Unknown subroutine (%s) requested</dt>
<dd>

<p>This module only exports the three subroutines described above. You asked for something else. Maybe you misspelled the subroutine you wanted.</p>

</dd>
</dl>

<h1 id="CONFIGURATION-AND-ENVIRONMENT"><a id="CONFIGURATION"></a>CONFIGURATION AND ENVIRONMENT</h1>

<p>IO::Interactive requires no configuration files or environment variables.</p>

<h1 id="DEPENDENCIES">DEPENDENCIES</h1>

<p>This module requires the <code>openhandle()</code> subroutine from the Scalar::Util module.</p>

<h1 id="INCOMPATIBILITIES">INCOMPATIBILITIES</h1>

<p>None reported.</p>

<h1 id="BUGS-AND-LIMITATIONS"><a id="BUGS"></a>BUGS AND LIMITATIONS</h1>

<p>No bugs have been reported.</p>

<p>Please report any bugs or feature requests to Github <a href="https://github.com/briandfoy/io-interactive/issues">https://github.com/briandfoy/io-interactive/issues</a>.</p>

<h1 id="SOURCE-AVAILABILITY"><a id="SOURCE"></a>SOURCE AVAILABILITY</h1>

<p>This code is in GitHub:</p>

<pre><code>        https://github.com/briandfoy/io-interactive</code></pre>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Damian Conway <code>&lt;DCONWAY@cpan.org&gt;</code></p>

<p>Currently maintained by brian d foy <code>&lt;bdfoy@cpan.org&gt;</code>.</p>

<p>1.01 patch DMUEY <code>dmuey@cpan.org</code></p>

<h1 id="LICENCE-AND-COPYRIGHT"><a id="LICENCE"></a>LICENCE AND COPYRIGHT</h1>

<p>Copyright &copy; 2005-2021, Damian Conway <code>&lt;DCONWAY@cpan.org&gt;</code>. All rights reserved.</p>

<p>This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p>

<h1 id="DISCLAIMER-OF-WARRANTY"><a id="DISCLAIMER"></a>DISCLAIMER OF WARRANTY</h1>

<p>BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE &quot;AS IS&quot; WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.</p>

<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.</p></div>

<div id="metacpan_install-instructions-dialog" class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Module Install Instructions</h4>
      </div>
      <div class="modal-body">
        <p>To install IO::Interactive, copy and paste the appropriate command in to your terminal.</p>
        <p><a href="https://metacpan.org/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p>
        <pre><code>cpanm IO::Interactive</code></pre>
        <p><a href="https://metacpan.org/pod/CPAN">CPAN shell</a></p>
        <pre><code>perl -MCPAN -e shell
install IO::Interactive</code></pre>
        <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p>
      </div>
      <div class="modal-footer">
        <a href="./IO::Interactive.html#" data-dismiss="modal" class="btn">Close</a>
      </div>
    </div>
  </div>
</div>
          </main>
          <div class="content-pagination">
          </div>
        </div>
        <footer class="footer">
          <div class="footer-container">
            <div class="footer-social">
              <div class="footer-link footer-logo">
                <a href="https://metacpan.org/">
                  <img src="https://metacpan.org/static/images/metacpan-logo.svg" alt="MetaCPAN" />
                </a>
              </div>
              <a class="footer-social-link" href="https://github.com/metacpan">
                <i class="fab fa-github-square"></i>
              </a>
              <a class="footer-social-link" href="https://fosstodon.org/@metacpan">
                <i class="fab fa-mastodon"></i>
              </a>
            </div>
            <div class="footer-links">
              <div class="footer-link">
                  <a href="https://metacpan.org/about">About</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/sponsors">Sponsor</a>
              </div>
              <div class="footer-link">
                  <a href="https://grep.metacpan.org">grep::cpan</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/recent">Recent</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/about/faq">FAQ</a>
              </div>
              <div class="footer-link">
                  <a href="https://metacpan.org/tools">Tools</a>
              </div>
              <div class="footer-link">
                  <a href="https://fastapi.metacpan.org/">API</a>
              </div>
              <div class="footer-link">
                  <a href="https://www.perl.org/">Perl.org</a>
              </div>
            </div>
            <div class="footer-sponsors">
              <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener">
                <img class="footer-sponsor-bytemark" src="https://metacpan.org/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener">
                <img class="footer-sponsor-liquidweb" src="https://metacpan.org/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener">
                <img class="footer-sponsor-deriv" src="https://metacpan.org/static/images/sponsors/deriv.svg" alt="Deriv logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener">
                <img class="footer-sponsor-geocode" src="https://metacpan.org/static/images/sponsors/geocodelogo.svg" alt="Geocode logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener">
                <img class="footer-sponsor-fastly" src="https://metacpan.org/static/images/sponsors/fastly_logo.svg" alt="Fastly logo">
              </a>
              <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener">
                <img class="footer-sponsor-opencage" src="https://metacpan.org/static/images/sponsors/open-cage.svg" alt="OpenCage logo">
              </a>
            </div>
          </div>
        </footer>
        <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts">
          <div class="modal-dialog">
            <div class="modal-content">
              <div class="modal-header">
                <button type="button" class="close" data-dismiss="modal">&times;</button>
                <h4 class="modal-title">Keyboard Shortcuts</h4>
              </div>
              <div class="modal-body row">
<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Global</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>s</kbd>
        </td>
        <td>Focus search bar</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>?</kbd>
        </td>
        <td>Bring up this help dialog</td>
      </tr>
    </tbody>
  </table>

  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>GitHub</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>p</kbd>
        </td>
        <td>Go to pull requests</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>go to github issues (only if github is preferred repository)</td>
      </tr>
    </tbody>
  </table>
</div>

<div class="col-md-6">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>POD</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>a</kbd>
        </td>
        <td>Go to author</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>c</kbd>
        </td>
        <td>Go to changes</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>i</kbd>
        </td>
        <td>Go to issues</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>d</kbd>
        </td>
        <td>Go to dist</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>r</kbd>
        </td>
        <td>Go to repository/SCM</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>s</kbd>
        </td>
        <td>Go to source</td>
      </tr>
      <tr>
        <td class="keys">
          <kbd>g</kbd> <kbd>b</kbd>
        </td>
        <td>Go to file browse</td>
      </tr>

    </tbody>
  </table>
</div>

<div class="col-md-12">
  <table class="table keyboard-shortcuts">
    <thead>
      <tr>
        <th></th>
        <th>Search terms</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><em>module:</em> (e.g. <a href="https://metacpan.org/search?q=module%3APlugin">module:Plugin</a>)</td>
      </tr>
      <tr>
        <td><em>distribution:</em> (e.g. <a href="https://metacpan.org/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td>
      </tr>
      <tr>
        <td><em>author:</em> (e.g. <a href="https://metacpan.org/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td>
      </tr>
      <tr>
        <td><em>version:</em> (e.g. <a href="https://metacpan.org/search?q=version%3A1.00">version:1.00</a>)</td>
      </tr>
    </tbody>
  </table>
</div>
              </div>
              <div class="modal-footer"></div>
            </div>
          </div>
        </div>
    </body>
</html>
